Event Report Templates

Event report templates contain a ReportDefinition page and a ReportSheet page, that together describe the reports you can produce. CygNet provides a sample report template file EventTemplate.xlsx for reference. It is stored in the CygNet\Services\FMS\ReportTemplates\Samples folder on your host server.

The ReportDefinition sheet includes the following parameters to describe the type of report to build.

ReportParameters
Worksheet

The ReportSheet sheet includes the following sections and corresponding tokens to describe the specific format of the report to build. Valid tokens will be replaced by the values they represent. You may also include additional information you wish to see in the report.

Header
SubReport Header
Data Table Header
Data Table
SubReport Footer
Report Footer

Displaying Additional (Non-Token) Values

You can enter additional (non-token) elements such as logos, labels, or text into reports. Elements that are not valid token values will be displayed as entered.

Note: This means that tokens with typographical errors, therefore not "valid" tokens, will also be displayed as entered.

Example

[EventCategory] is a valid token. If you use [Category] (not a valid token) instead of [EventCategory], the value will be displayed as "[Category]" instead of displaying the event category value desired, since [Category] is not a valid token.

[Category]

Configuring the ReportDefinition

The ReportDefinition uses parameters to describe the type of report for the service to build. The following parameters determine the described characteristics of your report.

Event Report: ReportParameters

Report parameters, which appear between #ReportParameters# and #End#, can be defined by the following values.

Parameter	Description	Value
ReportName	The value defined in this cell will be used for the report name, as it will appear in drop-down menus in FMS Explorer and CygNet Explorer. See Using the Reports Control and Scheduling FMS Command Tasks in the MSS for more information.	Enter a value to be used for the report name. Example Event
CommandName	The value defined in this cell will be used by the service to determine which specific report command type to execute. See FMSClient Methods in the Scripting section for more information.	Enter a value to specify the report command name. Example EVNR Note: Maximum of 7 characters; letters or numbers only, no spaces.

Parameter

Description

Value

ReportName

The value defined in this cell will be used for the report name, as it will appear in drop-down menus in FMS Explorer and CygNet Explorer.

See Using the Reports Control and Scheduling FMS Command Tasks in the MSS for more information.

Enter a value to be used for the report name.

Example

Event

CommandName

The value defined in this cell will be used by the service to determine which specific report command type to execute.

See FMSClient Methods in the Scripting section for more information.

Enter a value to specify the report command name.

Example

EVNR

Note: Maximum of 7 characters; letters or numbers only, no spaces.

Event Report: Worksheet Parameters

Event report worksheet parameters, which appear between #Worksheet# and #End#, can be defined by the following values.

Parameter	Description	Value
ReportType	The value defined in this cell will be used to represent the standard FMS report type you are configuring.	Enter a value to be used to indicate the type of the report. Example Event
NullToken	The value defined in this cell will be used to represent null values in your report.	Enter a value to be used to indicate a "null value" cell in the report. Example -
PageBreaks	The value defined in this cell will be used to specify whether or not to use page breaks in your report. If used, will force a page break after each device within a group.	Enter a value to indicate whether or not to use page breaks in the report. Options are Yes or No. Default value is Yes.
NoCmdGroupToken	The value defined in this cell will be used in your report to represent the value for the Group name or Group description fields when either of the following is true. command is not run against a group Node command is run against multiple group Nodes	Enter a value to be used to indicate the Group name or Group description when the command was not run against a single group Node. Example [Invalid Group]
NodeSortOrder	The value defined in this cell will be used to specify the order in which to display Node results in the report.	Enter one of the following options. Name ascending Description ascending Name descending Description descending Default value is Name ascending. This parameter is optional.
RptStDate	Note: If you use this parameter in your report template, the RptStDate parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Event Report Definitions (FMS Explorer) or Reports: Event (CygNet Explorer) for more information.	If used, enter a valid start date value for the report. RptStDate and RptEndDate must be the same configuration parameter type. Notes: The report will display data in Device time (D), although the report command parameters are configured relative to Contract time (C). The report will only include records that exist entirely within the specified date range. See Selecting Date and Time for more information. This parameter is optional.
RptEndDate	Note: If you use this parameter in your report template, the RptEndDate parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Event Report Definitions (FMS Explorer) or Reports: Event (CygNet Explorer) for more information.	If used, enter a valid end date value for the report. RptStDate and RptEndDate must be the same configuration parameter type. Notes: The report will display data in Device time (D), although the report command parameters are configured relative to Contract time (C). The report will only include records that exist entirely within the specified date range. See Selecting Date and Time for more information. This parameter is optional.

Configuring the ReportSheet

The ReportSheet uses tokens to describe the format of the report you want to run. The following tokens determine the report content, and will retrieve the corresponding values for display in your report.

Note: Enter report tokens carefully, as the tokens are case sensitive. Typographical errors (therefore not "valid" tokens) will be handled as "additional values" and displayed as entered; the non-token value will appear in your report instead of the actual value(s) the correctly entered token would have retrieved. See Displaying Additional (Non-Token) Values above for more information.

Event Report: Header Tokens

Event report headers, which appear above #EndReportHdr#, can be described by the following tokens.

Token	Description
[BeginDateTime]	The start date, in Contract day (C), of the requested time range for the report
[EndDateTime]	The end date, in Contract day (C), of the requested time range for the report
[CmdGroupName]	The name of the group Node against which the command was run, if applicable See also NoCmdGroupToken parameter.
[CmdGroupDesc]	The description of the group Node against which the command was run, if applicable See also NoCmdGroupToken parameter.
[GeneratedDateTime]	The time the report was generated, in Local time (L)
[TotalDeviceCount]	The total number of devices in the report

Event Report: SubReport Header Tokens

Event report subreport headers, which appear between #SubSection# SubReportHeader and #End#, can be described by the following tokens.

Token	Description
[=]	When used as the first three characters, turns the cell into a formula
[RowNumber]	The current row number
[CurrentDeviceCount]	The index of the device being displayed
[TotalDeviceCount]	The total number of devices in the report
[NodeContractHour]	The contract hour of the Node
[NodeDaysOfData]	The number of days for which the data source of the Node will retain data
[NodeDesc]	The Node description
[NodeId]	The Node ID
[NodeInstallDateTime]	The install date/time for the Node, in Device time (D)
[NodeName]	The Node name
[NodePollingFacilityId]	The polling facility ID of the Node
[NodePollingFacilityTag]	The polling facility tag of the Node
[NodePollingSiteService]	The polling Site.Service of the Node
[NodeReportingFacilityId]	The reporting facility ID of the Node
[NodeReportingSiteService]	The reporting Site.Service of the Node
[NodeSecurityApp]	The security application of the Node
[NodeSortPriority]	The sort priority of the Node
[NodeTimezone]	The time zone configured for the Node
[NodeTimezoneUsingDst]	The daylight saving time status of the Node
[NodeType]	The Node type
[PollingFac_Attr0] - [PollingFac_Attr39]	Polling facility indexed text attributes 0 through 39 (each a separate token)
[PollingFac_Category]	Polling facility category
[PollingFac_Comment]	Polling facility comment attribute
[PollingFac_Desc]	Polling facility description
[PollingFac_Info0]	Polling facility info attribute 0 Default attribute name is Facility Location
[PollingFac_Info1]	Polling facility info attribute 1 Default attribute name is Facility Contact
[PollingFac_IsActive]	Polling facility active flag
[PollingFac_Table0] - [PollingFac_Table59]	Polling facility indexed table-driven attributes 0 through 59 (each a separate token)
[PollingFac_Type]	Polling facility type
[PollingFac_YesNo0] - [PollingFac_YesNo19]	Polling facility indexed Yes/No attributes 0 through 19 (each a separate token)
[RecordSpan]	The number of minutes in the record span

Event Report: Data Table Header Tokens

Event report data table headers, which appear between #SubSection# DataTableHeader and #End#, can be described by the text you enter. Type the desired text into the cell, and format it as desired. Data Table Headers can also be described by the following tokens.

Note: In PDF format, reports containing tables that span multiple pages will repeat the data table header on each contiguous page.

Token	Description
[=]	When used as the first three characters, turns the cell into a formula
[RowNumber]	The current row number
[CurrentDeviceCount]	The index of the device being displayed
[TotalDeviceCount]	The total number of devices in the report
[NodePollingFacilityId]	The polling facility ID of the Node
[NodePollingFacilityTag]	The polling facility tag of the Node
[NodePollingSiteService]	The polling Site.Service of the Node
[NodeReportingFacilityId]	The reporting facility ID of the Node
[NodeReportingSiteService]	The reporting Site.Service of the Node

Event Report: Data Table Tokens

Event report data table parameters, which appear between #SubSection# DataTable (1 or 2) and #End#, can be described by the following tokens.

Token	Description
[=]	When used as the first three characters, turns the cell into a formula
[FirstRow]	The row number of the first row in the data table
[RowNumber]	The current row number
[BeginDateTime]	The start date, in Contract day (C), of the time range for the record
[EventAdditionalInfo]	Additional information regarding the event
[EventCategory]	The category of the event
[EventDataSource]	The data source of the event
[EventSequence]	The sequence of the event
[EventType]	The type of the event
[EventValueNew]	The new value, resulting from the event
[EventValueOld]	The old value, prior to the event
[EventValueType]	The value type of the event
[EventValueUnits]	The units used for the selected event value
[PollingFac_Attr0] - [PollingFac_Attr39]	Polling facility indexed text attributes 0 through 39 (each a separate token)
[PollingFac_Category]	Polling facility category
[PollingFac_Comment]	Polling facility comment attribute
[PollingFac_Desc]	Polling facility description
[PollingFac_Info0]	Polling facility info attribute 0 Default attribute name is Facility Location
[PollingFac_Info1]	Polling facility info attribute 1 Default attribute name is Facility Contact
[PollingFac_IsActive]	Polling facility active flag
[PollingFac_Table0] - [PollingFac_Table59]	Polling facility indexed table-driven attributes 0 through 59 (each a separate token)
[PollingFac_Type]	Polling facility type
[PollingFac_YesNo0] - [PollingFac_YesNo19]	Polling facility indexed Yes/No attributes 0 through 19 (each a separate token)

Event Report: SubReport Footer Tokens

Event report subreport footers, which appear between #SubSection# SubReportFooter and #End#, can be described by the following tokens.

Token	Description
[=]	When used as the first three characters, turns the cell into a formula
[FirstRow]	The row number of the first row in the data table
[RowNumber]	The current row number
[CurrentDeviceCount]	The index of the device being displayed
[TotalDeviceCount]	The total number of devices in the report
[NodeContractHour]	The contract hour of the Node
[NodeDaysOfData]	The number of days for which the data source of the Node will retain data
[NodeDesc]	The Node description
[NodeId]	The Node ID
[NodeInstallDateTime]	The install date/time for the Node, in Device time (D)
[NodeName]	The Node name
[NodePollingFacilityId]	The polling facility ID of the Node
[NodePollingFacilityTag]	The polling facility tag of the Node
[NodePollingSiteService]	The polling Site.Service of the Node
[NodeReportingFacilityId]	The reporting facility ID of the Node
[NodeReportingSiteService]	The reporting Site.Service of the Node
[NodeSecurityApp]	The security application of the Node
[NodeSortPriority]	The sort priority of the Node
[NodeTimezone]	The time zone configured for the Node
[NodeTimezoneUsingDst]	The daylight saving time status of the Node
[NodeType]	The Node type
[PollingFac_Attr0] - [PollingFac_Attr39]	Polling facility indexed text attributes 0 through 39 (each a separate token)
[PollingFac_Category]	Polling facility category
[PollingFac_Comment]	Polling facility comment attribute
[PollingFac_Desc]	Polling facility description
[PollingFac_Info0]	Polling facility info attribute 0 Default attribute name is Facility Location
[PollingFac_Info1]	Polling facility info attribute 1 Default attribute name is Facility Contact
[PollingFac_IsActive]	Polling facility active flag
[PollingFac_Table0] - [PollingFac_Table59]	Polling facility indexed table-driven attributes 0 through 59 (each a separate token)
[PollingFac_Type]	Polling facility type
[PollingFac_YesNo0] - [PollingFac_YesNo19]	Polling facility indexed Yes/No attributes 0 through 19 (each a separate token)
[RecordSpan]	The number of minutes in the record span

Event Report: Report Footer

Event report footers, which appear between #SubSection# ReportFooter and #End#, can be described by the text you enter. Type the desired text into the cell, and format it as desired.